gh-87904: Document curses classes#151643
Conversation
Add docstrings for the curses.window, curses.error, curses.panel.panel and curses.panel.error classes. Document the panel class and its error exception in curses.panel.rst, using the real lowercase panel name.
serhiy-storchaka
added
needs backport to 3.14
Documentation build overview
|
serhiy-storchaka
requested review from
AA-Turner and
StanFromIreland
as code owners
|
@encukou, are these IDs case-sensitive? |
| c-api/typeobj.html: c.Py_tp_bases | ||
|
|
||
| # curses.panel.panel is the correct class name. | ||
| library/curses.panel.html: curses.panel.Panel.above |
There was a problem hiding this comment.
I think it would be better to preserve them, like we do elsewhere by injecting some anchors:
.. raw:: html
<!-- Keep the old URL fragments working (see gh-89554) -->
<span id='thread.lock.acquire'></span>
<span id='thread.lock.release'></span>
<span id='thread.lock.locked'></span>
|
Alternative solution -- rename |
|
I think it is better to resolve such issues on the HTML server side, if possible. Or add a special Sphynx extension. This PR is needed for #151748. |
Server redirects can be added to https://github.com/python/psf-salt/blob/main/salt/docs/config/nginx.docs-redirects.conf. Hugo proposed a Sphinx extension above, it "redirects" by creating files at the locations pointing to the new location. |
3 participants
Add docstrings for the curses.window, curses.error, curses.panel.panel and curses.panel.error classes. Document the panel class and its error exception in curses.panel.rst, using the real lowercase panel name.